Setup and Installation

Smart Integration Connector Setup Overview

You must set up Smart Integration Connector in this order:

1. Install the OneStream Smart Integration Connector Local Gateway Server (OneStreamSmartIntegrationConnectorGateway.msi) on a Windows Server 2019+ in your environment.

2. Create a gateway in the OneStream Windows application to connect OneStream Cloud instance to a Local Gateway on the Local Gateway Server.

3. Export the gateway configuration and import this configuration to the Gateway Settings in the OneStream Local Gateway Configuration.

4. For Database Connection gateways, to allow connections to local databases:

   1. Define a Local Gateway connection including Data Sources through the OneStream Local Gateway Configuration.

   2. Test any configured Data Sources to confirm they are communicating properly.
      

      NOTE: Testing direct connections may involve building test business rules to perform proper validation.

   3. Define a custom database connection in the OneStream System Configuration Setup.

When installation is complete, you can access remote data sources using business rules, member formulas, or dashboard data adapters in OneStream through the Smart Integration Connector.

Gateway Terms

The Smart Integration fields define the gateway. You can find more information about this below.

Term	Definition
Relay Name	Refers to the internal namespace of the relay service that is responsible for managing the data flow for all defined Gateways. For example, arn-mysite.servicebus.windows.net.
IPv4 Whitelist	Contains the list of IPs or CIDR addresses that are allowed to transfer data through Smart Integration Connector.
Name	The name of the gateway. Gateway names are completely arbitrary and typically refer to the region (North East) or data source such as (SAP). The gateway name cannot be changed once created, and they must be unique across all environments—both development and production. You can delete an existing gateway and recreate it with a new name.
Description	Text describing the role and purpose for the gateway and the data sources to which it is connecting.
Gateway Server Name	Use for display and organizational purposes only. This is the name of the gateway server associated with the gateway. You can select an existing gateway server or enter a new one.
Web API Key (Database Connections only)	This is an editable field. You can change your key as needed. If changed, it must also be changed in the Smart Integration Connector Local Gateway Server. It is designed to offer an additional layer of protection within your network when invoking APIs embedded in the Smart Integration Connector Local Gateway Server. The purpose of the Web API Key is to give you full control on who can access the data sources in your network.
Gateway Key	This is the cloud key used to authenticate the Smart Integration Connector gateway to the customer OneStream environment. This key can be rotated in the OneStream application by Smart Integration Connector Gateway administrators and must be the same in both the remote Gateway service and in OneStream.
Status	Value will be Online if the local gateway is running and returning heartbeat messages back to OneStream. If the Smart Integration Connector Local Gateway Server is unavailable, stopped, or network connectivity is interrupted, it will display Offline.
Status Indicators	Status indicators in the list of gateways provide a visual indication of the Gateway status. Green: The Gateway is Online. Red: The Gateway is Offline. Yellow: (Database Connections only) The Gateway is Online and an update to the Local Gateway Server is available. NOTE: For Direct Connections, the yellow status is not displayed as these connections do not report a version number back to OneStream.
Instance Count	Displays the count of active gateways. Grayed out by default. While this value is typically 1 when the gateway is online, you may have a listener count of two or more if there are redundant active gateways for high availability. By default, OneStream allows a total of five active gateways per environment. This can be increased by contacting Support.
Version (Database Connections Only)	Displays the Smart Integration Connector Local Gateway Server version. This version may be different from the deployed version of OneStream and allows administrators to observe and monitor versions of Smart Integration Connector Gateway software deployed.
Active Local Gateway Server Computer Name (Database Connections Only)	Displays the computer name of the currently active local gateway server.
Bound Port at Gateway	Remote port bound to Gateway endpoint. Database Connection Gateways default to 20433 and should not be changed without consulting support. Direct Connection Gateways allow any port running on a remote host to be used. This port represents the well-known TCP service to expose from an on-premises host such as sFTP, which would equate to port 22.
Remote Gateway Host (Direct Connections Only)	Remote port host to Gateway Server. Used if surfacing an endpoint such as an SFTP Server. This could be the hostname or IP address on the network that the Gateway Server resides in. For example: 172.168.4.7 or sftp.mycompany.com
Bound Port in OneStream (Direct Connections Only)	This is an customer defined port that can be referenced in data management or business rules to directly access services such as sFTP and WebAPI. This must be a globally unique port in a OneStream deployment environment per direct connection and should be a TCP port number > 1024 and <65535. When creating the gateway, use the default of -1 and OneStream will automatically assign an open port.
Gateway failures reporting interval (min)	Minutes to wait between reporting gateway failures into the OneStream Error Log. The default is five minutes and the max is 1440 minutes. If a gateway is unreachable, an item is put in the error log using this interval value in minutes and the minutes can be adjusted.

Local Gateway Server Installation

Smart Integration Connector is available in OneStream from the System > Administration tab.

1. Download the Smart Integration Connector installer (OneStream_Connector_#.#.#.zip) file from the Platform section of the Solution Exchange.
   

2. Copy the Smart Integration Connector Local Gateway Server installer to a Windows Server within your environment.

3. Run the installer as an administrator. Accept all the default prompts. When completed, the Local Gateway Server will be installed on your Windows Server.

   IMPORTANT: If you are upgrading, you must follow steps 4-7.

4. Run the OneStream Local Gateway Configuration Utility.

5. The XFGatewayConfiguration.xml file will open by default.

   IMPORTANT: Do not change the name of the XFGatewayConfiguration.xml file. The OneStream Smart Integration Connector Gateway Service only references this XFGatewayConfiguration.xml file upon start-up. The Save As functionality is used to create a backup of the file. Do not rename, move, or change the location of the XFGatewayConfiguration.xml file.

6. Save the configuration file.

7. Follow the dialog prompts and restart the service.

Create a Database Connection Gateway

Database Connection Gateways are used to connect OneStream to the Smart Integration Connector Local Gateway Server over the Azure Relay. At least one Database Connection Gateway is required for Smart Integration Connector to function properly. After the gateway is created, you will need to copy the configuration to the Smart Integration Connector Local Gateway Server using the OneStream Local Gateway Configuration.

NOTE: For descriptions of the fields in this procedure, see Gateway Terms.

To create a Database Connection Gateway:

1. Go to System > Administration > Smart Integration Connector.

2. Click Create New Gateway.

3. Enter the Name and Description.

   NOTE: The Gateway name cannot be changed once created and must be deleted and re-created.

4. Select the Gateway Server from the drop-down, or enter a new Gateway Server name in the same field. If this is the first Gateway being created, enter the name of the Gateway Server.

   NOTE: It is common practice to use the hostname or IP of your SIC Local Gateway Server as the "Gateway Server" name. The Gateway Server name is only used to organize servers when multiple Smart Integration Connector servers are set up.

5. From Connection Type, select Database Connection.

   

   NOTE: Each Gateway Server will only have one Database Connection and as such we recommend naming it "Database_Gateway_" followed by the name used for "Gateway Server." This will differentiate the Database Connection Gateways in future steps.

6. The Web API Key is used as an additional layer of security when communicating with the Smart Integration Connector Local Gateway Server internal APIs.

   NOTE: WebAPI keys are not required, but are best practice to enhance security and can be modified or added at any time. The Local Gateway Service introduces a WebAPI exposed only to OneStream and bound only to localhost on the server it is deployed to. This WebAPI is inaccessible on the remote network. If the Local Gateway Service is bound to other network interfaces, it is suggested to use the WebAPI as a mechanism to enhance security on the remote network preventing unauthorized use of OneStream WebAPIs.

7. Copy the configuration to the Smart Integration Connector Local Gateway Server using the OneStream Local Gateway Configuration. For details, see Export and Import the Gateway Configuration.

Create a Direct Connection Gateway (Optional)

A Direct Connection Gateway is a point-to-point channel to a specific remote network resource such as an sFTP server or Web API (including iPaaS services).

NOTE: At least one database connection is required to use a Direct Connection Gateway. The Database Connection Gateway because the database connection is used to monitor the availability of the remote Smart Integration Connector Gateway server.

The existence of a database connection does not necessarily mean it must be used or configured to a data source if only Direct Connections are desired.

NOTE: For descriptions of the fields in this procedure, see Gateway Terms.

To create a direct connection:

1. (Required) A Database Connection Gateway must be created before the Direct Connection Gateway is created. The Database Connection Gateway is used to monitor the availability of the remote Smart Integration Connector Gateway server. For details, refer to Create a Database Connection Gateway.

2. Go to System > Administration > Smart Integration Connector.

3. Click Create New Gateway.

4. Enter the Name and Description.

   NOTE: The Gateway name cannot be changed once created and must be deleted and re-created.

5. Select the Gateway Server from the drop-down, or enter a new Gateway Server name in the same field. If this is the first Gateway being created, enter the name of the Gateway Server.

   NOTE: It is common practice to use the hostname or IP of your SIC Local Gateway Server as the "Gateway Server" name. The Gateway Server name is only used to organize servers when multiple Smart Integration Connector servers are set up.

6. From Connection Type, select Direct Connection (e.g, SFTP, WebAPI).

7. Enter the Bound Port at Gateway. This port represents the well-known TCP service to expose from an on-premises host such as SFTP, which would equate to port 22.

   NOTE: The remote service port is required to configure the connection and may require consultation with network or IT resources to obtain it. It is also required that any firewalls between the Local Gateway Server and the remote host allow traffic to the destination port specified.

8. Enter the Remote Gateway Host (for example, localhost). This represents the remote host name or IP address accessible by the OneStream Smart Integration Connector Local Gateway Server. If the host or IP address is accessible or resolvable from the OneStream Smart Integration Connector Gateway service or using remote resources accessible through on-premises WAN, it can be exposed for use.

9. Enter a Bound Port in OneStream. It is a best practice to use -1 for this value as the OneStream application servers will locate an unused and available port to map to this connection. This port number must be globally unique across all application servers in a OneStream deployment, and care should be taken if a port is specified. This is the port that is used to access the remote host through business rules and data management jobs from OneStream application servers to allow network traffic to traverse to the remote host and port.

10. Using this direct connection in OneStream is done by accessing localhost: [Bound Port In OneStream] which will tunnel traffic back to the configured remote Gateway Host to the configured bound port at gateway.

    

    • Example: Remote SFTP server at 172.168.3.4 listening on port 22.

    • Bound Port in OneStream is configured as port 45000. Note that when -1 is used, the selected port number is available/displayed after saving and also surfaced in the OneStream Error Log.

    • In OneStream Business Rules, you can access the remote host by connecting to localhost:45000.

    • In a OneStream Business Rule, this port can also be obtained in code allowing this port number to be changed without updating Business Rules:

      Copy

      Dim gatewayDetails As GatewayDetails = BRApi.Utilities.GetGatewayConnectionInfo(si, "northamerica_sftp") 
      Dim remotePort = gatewayDetails.OneStreamPortNumber

Export and Import the Gateway Configuration

You must copy the gateway configuration settings and paste them into your Smart Integration Connector Gateway to establish the connection.

1. Go to System > Administration > Smart Integration Connector.

2. Select the Gateway to export.

3. Click Export Gateway Configuration. The Gateway Configuration Details are copied to the clipboard.

   

4. On your Windows Server, open the OneStream Local Gateway Configuration. This runs as administrator by default.

5. The existing XFGatewayConfiguration.xml opens by default.

6. Click next to Local Gateway Settings.

   

7. Click next to Local Gateways.

   

8. Import the previously copied Gateway Configuration.

   

9. Click Apply.

10. Click Test Connection to test the connection.

    

11. Click OK twice.

12. Save the configuration.

13. Click Yes to apply the changes and restart the Local Gateway Server.

New Gateway Key Generation

Smart Integration Connector administrators can rotate the Gateway Key maintained by the underlying cloud service; however, it must be the same for both the Smart Integration Connector local gateway and the gateway configuration in the OneStream Windows Application to function properly.

1. Select an existing gateway.

2. Click Regenerate Gateway Key for Selected Gateway.

   

3. You must re-export your Gateway Configuration and apply the new settings throughout the OneStream Local Gateway Configuration. See Export and Import the Gateway Configuration.

4. Click OK.

Create a Local Gateway Connection to a Data Source

A data source contains the name, connection string, and database provider for the database of your choice. You can set up a PostgreSQL, SQL, Oracle, OleDb, MySQL, ODP.net, or Microsoft ODBC connection. The data source is configured using the Local Gateway Configuration Utility. The utility was installed as part of the Smart Integration Connector Local Gateway installation.

1. Start the OneStream Local Gateway Configuration.

2. The existing XFGatewayConfiguration.xml opens by default.

3. Click to configure LocalGateway Connections details to set up the Data Sources to local databases, APIs, or other on-premises resources.

   

4. Click next to Data Sources.

   

5. Click Add Item to add a new data source.

   

6. If you have a password for the connection string, enter it in the Connection String Password field. The password is masked for security. Then, when you need to enter your connection string password, use the substitution variable: |password|
   Example:
   Data Source=localhost;Initial Catalog=Sales_DB;Persist Security Info=True;User ID=sa;Password=|password|;

7. Enter the Data Source Name, Connection String, and select a Database Provider.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

   You can add as many data sources as necessary. The Data Source Name must be unique for each connection defined within a specific OneStream Smart Integration Connector Local Gateway Server. Names can be re-used across deployed instances of the Windows Service across your network. See the examples below for connection string examples to a variety of relational data sources such as PostgreSQL, SQL, and ODBC, and Oracle. Connection Strings are encrypted automatically. You can edit the plain text string by clicking the ellipsis.

   NOTE: Oracle databases require drivers and specific configuration provided by Oracle.

8. Click OK to save your configuration.

   IMPORTANT: The connection strings below include user IDs and the password substitution variable. You can also use integrated security to remove plain text user IDs and passwords from connection strings in Smart Integration Connector. See Remove UserID and Passwords by Integrated Security.

Microsoft SQL Server

Below is an example for setting up a SQL database using the SqlClient provider.

1. Click next to Data Sources.

2. Click Add Item to add the data source.

3. Data Source Name: Northeast_Sales

4. Connection String:
   with UserID / Password:
   Server=localhost;Initial Catalog=Sales_DB;User ID=sa;Password=|password|;Max Pool Size=1000;Connect Timeout=60;

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. From Database Provider, select SqlClient Data Provider.

7. Click Test Connection to test the data source.

8. Click OK to save.

MySQL Data Provider

Below is an example for setting up a MySQL Data Provider.

1. Click next to Data Sources.

2. Click Add Item to add a new data source.

3. Data Source Name: Sales_UK

4. Connection String:
   Server = localhost;Port=3306;uid=root;pwd=|password|;database=gatewaymysql;

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. From Database Provider, select MySQL Data Provider.

7. Click Test Connection to test the data source.

8. Click OK to save.

Oracle Database Examples

Connecting to Oracle requires the download and configuration of the Oracle Data Access Components (ODAC) obtained directly from Oracle’s website. Follow the steps below to get access to these drivers and files.

1. Go to the latest web page for Oracle .NET and Visual Studio ODAC Downloads for Oracle Database.

2. After installation, the ODP.NET Provider will display as an available Database Provider in the utility when adding a new data source.

3. The connection string for Oracle databases can be set up to either reference or require a locally defined tnsnames.ora file for the requested data sources.

   

Example Connection Strings:

• Oracle Data Provider for .NET: Data Source=oracletest;User Id=OneStream1;Password=|password|;

• Oracle Data Provider without TNSNames.ora: Data Source=(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=MyHost)(PORT=MyPort)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=MyOracleSID))); User Id=myUsername;Password=|password|;

OracleClient Database Provider

Below is an example for setting up a OracleClient database provider.

1. Click next to Data Sources.

2. Click Add Item to add the data source.

3. Data Source Name: Sales_EMEA

4. Connection String: Data Source=oracletest;User Id=OneStream1;Password=|password|

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. From Database Provider, select OracleClient Data Provider.

7. Click Test Connection to test the data source.

8. Click OK to save.

Oracle Data Provider for .NET

Below is an example for setting up a Oracle Data Provider for .NET.

1. Click next to Data Sources.

2. Data Source Name: Sales_SouthAmerica

3. Connection String:
   Data Source=oracletest;User Id=OneStream1;Password=|password|

4. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

5. From Database Provider, select Oracle Data Provider for .NET.

6. Click Add Item to add a new data source.

7. Click Test Connection to test the data source.

8. Click OK to save.

PostgreSQL (Npgsql Data Provider)

Below is an example for setting up a PostGres database.

1. Click next to Data Sources.

2. Click Add Item to add the data source.

3. Data Source Name: RevenueMgmtPostGres

4. Connection String: Server=localhost;Port=5432;Database=revmgt;User Id=onestream;Password=|password|;

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. From Database Provider, select Npgsql Data Provider.

7. Click Test Connection to test the data source.

8. Click OK to save.

OleDb Data Provider

Below is an example for setting up an Oracle database. This does not require additional download and configurations.

1. Click next to Data Sources.

2. Click Add Item to add the data source.

3. Data Source Name: Sales_Asia

4. Connection String: Provider=OraOLEDB.Oracle;Data Source=localhost:1521/XE;Initial Catalog=myDataBase;User Id=myUsername;Password=|password|;

   (missing or bad snippet)

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. From Database Provider, select OleDb Data Provider.

7. Click Test Connection to test the data source.

8. Click OK to save.

ODBC Data Provider

1. Click next to Data Sources.

2. Click Add Item to add the data source.

3. Data Source Name: Sales_Europe

4. Connection String: Driver={Microsoft ODBC for Oracle};Server=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=199.199.199.199)(PORT=1523))(CONNECT_DATA=(SID=dbName)));Uid=myUsername;Pwd=|password|;

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. From Database Provider , select Odbc Data Provider.

7. Click Test Connection to test the data source.

8. Click OK to create the new source.

9. Click Save.

(Optional) Remove UserID and Passwords by Integrated Security

You can remove UserIDs and Passwords from connection strings in Smart Integration Connector if your organization has concerns over credential storage in the Smart Integration Connector Gateway configuration file. This requires running the Windows Service under a Service Account identity and using integrated security to connect to remote data sources, which eliminates local storage of any plain text credentials. Additionally, ODBC data sources can be defined (using a system DSN) to remove credentials from the configuration file.

Update the Local Gateway Connection String

1. Open your OneStream Local Gateway Configuration.

2. Open a Local Gateway Connection.

3. Navigate to the Connection String and use an Integrated or Trusted Security string. For example: Data Source=localhost,Initial Catalog=OneStream_GolfStreamDemo_2022;Trusted_Connection=True;

   

   NOTE: Trusted Connections use the UserID and password you use to log into the Windows Server.

   NOTE: The example above is for SQL server. Trusted connections vary by Data Provider type.

4. Click OK.

5. Save your Data Source.

Update Permissions on the Service

1. Open Windows Services.

2. Navigate to OneStream Smart Integration Connector Gateway. The service should be running.

   

3. Right-click and open Properties.

4. Click the Log On tab. Typically, this will default to the Local System account.

   IMPORTANT: Before moving to the next step, ensure that you have the appropriate permissions and approvals from your IT Administrators to complete the Log On change. The service account used will require local Administrative rights to access resources on the Windows server, such as the machine certificate store and private keys used for encryption. This account will also require the appropriate permissions to access the database such as Microsoft SQL Server.

5. Change log on from Local System account to This account and enter your domain or login that has access to the data source. Depending on how your SSO is configured, your account could require your domain name, UserID, and password. Contact your IT Administrator if you have questions about your account domain.

   

6. Click Apply.

7. Click OK.

8. Right-click and select Restart to restart and update the service.

Test the Updated Integrated Connection String

You should test your connection through a Data Adapter query to verify your access to Smart Integration Connector. An alternate SQL Query to pulling the first 10-50 rows is sufficient. See Data Adapters Example.

Microsoft Entra Authentication for Azure SQL

1. Open your OneStream Local Gateway Configuration.

2. Open a Local Gateway Connection.

3. Enter a Data Source Name of MicrosoftEntra.

4. Navigate to the Connection String and enter a connection string. Example: Server=demo.database.windows.net; Authentication=Active Directory Service Principal; Encrypt=True; Database=testdb; User Id=AppId; Password=|password|;

5. Enter your Connection String Password.

   NOTE: For security purposes, we recommend using the Connection String Password field and the substitution variable to ensure the password is not shown on screen. However, you can also embed the password directly within your connection string. For example: Server = localhost;Port=3306;uid=root;pwd=my_password;database=gatewaymysql;.

6. Select MS Data SQL Provider as your Database Provider.

   

7. Click Test Connection to test the data source.

8. Click OK.

9. Click Save.

Restart OneStream Smart Integration Connector Gateway

1. Open the OneStream Local Gateway Configuration.

2. Click Tools > Restart OneStream Smart Integration Connector Gateway.

   

Redundant and Fail-over Gateways

The Smart Integration Connector Local Gateway Server can be installed on a separate Windows Server to operate as a fail-over. The Local Gateway Server Gateway establishes connection to the Relay that becomes the ac/primary Local Gateway Server instance while the second Local Gateway Server environment remains idle until the primary goes offline. The second Local Gateway Server Gateway would be the fail-over in this scenario and automatically accept traffic if the primary server instance were to go offline. See Create a Redundant or Fail-over Gateway.

Create a Redundant or Fail-over Gateway

To create a redundant or fail-over gateway, you must set up Smart Integration Connector in this order:

1. Complete installation on the primary Local Gateway Server and verify all data connections transfer data.

2. On the secondary server, install the OneStream Smart Integration Connector Local Gateway Server (OneStreamSmartIntegrationConnectorGateway.msi) on a Windows Server 2019+ in your environment.

NOTE: If you are using custom DLLs, SAP, or referenced DLLs, you must copy the existing Referenced Assemblies Folder. Locations must be in sync and in the same location on the primary server. See Smart Integration Connector Settings.

1. On the secondary server, perform the following steps:

   1. Open the OneStream Local Gateway Configuration.

   2. Go to Tools > Import Configuration from Primary Gateway Server.

      1. Choose the location of the file and select Open.

         CAUTION: You will overwrite the existing local gateway configuration. If you use Connection String Passwords, you will need to reenter a connection string password.

         CAUTION: If you installed a custom database driver, you must install the customer database driver on the backup gateway server.

      2. Click Local Gateway Connections > Data Sources.

      3. Select a Data Source and the Connection String Passwords.

      4. Select OK to provide a new Connection string.

      5. Delete the encrypted text and replace it with a valid connection string from the primary server.

      6. Select OK to encrypt the connection string and close the dialog box.

      7. Repeat steps a through f for all the remaining data sources.

      8. Click OK to close the Data Sources.

      9. Click OK to close the Local Gateway Connections.

      10. Click Save to save the Local Gateway Configuration.

      11. Click Yes to restart the service.

      12. Test the Smart Integration Connector Local Gateway Server in OneStream.

2. Verify the Instance Count is 2 when both the primary and secondary servers are running in the OneStream Windows App.

   

   NOTE: If Instance Count is over 2, the active gateway will display and not the fail-over.

Define Connections in OneStream System Configuration Setup

1. Go to System > Administration > System Configuration.

2. Select Application Server Configuration > Database Server Connections.

   

3. Select Create Item to create a new Custom database server connection.

   NOTE: If the only fields displayed are Name and External Database properties, verify that the current user is assigned to the ManageSystemConfiguration role.

4. Enter the Name of the Database Server Connection.

5. For Database Provider Type, select Gateway.

   

6. The Gateway Name drop-down menu will be populated with a list of configured Gateways. Select the Gateway.

7. After the Gateway is selected, the Data Source Name drop-down menu populates with a list of the Local Gateway Server Database Connections.

8. Select a Database Connection from the drop-down menu.

   NOTE: If the remote data source is not displayed or the Gateway is offline, you can select Custom to allow the data source to be manually specified. It is advised to wait up to five minutes for the Gateway to populate first.

9. Click Save to complete the configuration.

10. Verify the custom database connection is under Custom.